API Documentation
Popup.h
1 // Popup.h
3 //
5 
6 namespace nkWinUi
7 {
11  enum class POPUP_TYPE
12  {
13  POPUP_TYPE_OK = 0,
20  POPUP_TYPE_HELP = 0x4000L
21  } ;
22 
26  enum class POPUP_RESULT
27  {
38  } ;
39 }
40 
41 namespace nkWinUi
42 {
46  class DLL_WINUI_EXPORT Popup : public Window
47  {
48  public :
49 
53  Popup () ;
57  ~Popup () ;
58 
62  virtual void setParentComponent (Component* parent, bool makeItVisible = true) override ;
63 
67  virtual void pop () ;
71  virtual void unpop () ;
72 
82  static POPUP_RESULT pop (POPUP_TYPE type, const char* title, const char* message, Component* parent) ;
83  } ;
84 }
nkWinUi::POPUP_TYPE
POPUP_TYPE
Types of popup available.
Definition: Popup.h:12
nkWinUi::POPUP_RESULT::POPUP_RESULT_RETRY
@ POPUP_RESULT_RETRY
User clicked retry.
nkWinUi::POPUP_RESULT::POPUP_RESULT_NO
@ POPUP_RESULT_NO
User clicked no.
nkWinUi::Popup::~Popup
~Popup()
nkWinUi::POPUP_TYPE::POPUP_TYPE_YES_NO
@ POPUP_TYPE_YES_NO
A popup requesting for agreement.
nkWinUi::POPUP_RESULT::POPUP_RESULT_IGNORE
@ POPUP_RESULT_IGNORE
User clicked ignore.
nkWinUi::POPUP_RESULT::POPUP_RESULT_YES
@ POPUP_RESULT_YES
User clicked yes.
nkWinUi::POPUP_RESULT::POPUP_RESULT_OK
@ POPUP_RESULT_OK
User clicked ok.
nkWinUi::POPUP_TYPE::POPUP_TYPE_ABORT_RETRY_IGNORE
@ POPUP_TYPE_ABORT_RETRY_IGNORE
A popup requesting if something should be aborted, retried, or ignored.
nkWinUi::Component
Base class for any graphical component.
Definition: Component.h:12
nkWinUi::POPUP_TYPE::POPUP_TYPE_CANCEL_TRY_CONTINUE
@ POPUP_TYPE_CANCEL_TRY_CONTINUE
A Popup requesting to cancel, try, or continue.
nkWinUi::POPUP_RESULT
POPUP_RESULT
Result answers possible from a popup.
Definition: Popup.h:27
nkWinUi::POPUP_RESULT::POPUP_RESULT_TRY_AGAIN
@ POPUP_RESULT_TRY_AGAIN
User clicked try.
nkWinUi::Popup
A graphical popup window.
Definition: Popup.h:47
nkWinUi::Popup::pop
static POPUP_RESULT pop(POPUP_TYPE type, const char *title, const char *message, Component *parent)
nkWinUi::Popup::pop
virtual void pop()
nkWinUi::Window
A graphical window.
Definition: Window.h:12
nkWinUi::Popup::setParentComponent
virtual void setParentComponent(Component *parent, bool makeItVisible=true) override
nkWinUi::POPUP_TYPE::POPUP_TYPE_OK
@ POPUP_TYPE_OK
A simple informative popup with an ok button.
nkWinUi::Popup::Popup
Popup()
nkWinUi::POPUP_TYPE::POPUP_TYPE_OK_CANCEL
@ POPUP_TYPE_OK_CANCEL
A popup requesting for agreement.
nkWinUi::Popup::unpop
virtual void unpop()
nkWinUi::POPUP_RESULT::POPUP_RESULT_UNKNOWN
@ POPUP_RESULT_UNKNOWN
Unknown place holder.
nkWinUi::POPUP_RESULT::POPUP_RESULT_CONTINUE
@ POPUP_RESULT_CONTINUE
User clicked continue.
nkWinUi::POPUP_TYPE::POPUP_TYPE_HELP
@ POPUP_TYPE_HELP
A Popup showing a help tooltip.
nkWinUi::POPUP_RESULT::POPUP_RESULT_CANCEL
@ POPUP_RESULT_CANCEL
User clicked cancel.
nkWinUi::POPUP_RESULT::POPUP_RESULT_ABORT
@ POPUP_RESULT_ABORT
User clicked abort.
nkWinUi::POPUP_TYPE::POPUP_TYPE_YES_NO_CANCEL
@ POPUP_TYPE_YES_NO_CANCEL
A popup requesting for agreement or cancelling.
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Button.h:7
nkWinUi::POPUP_TYPE::POPUP_TYPE_RETRY_CANCEL
@ POPUP_TYPE_RETRY_CANCEL
A popup asking to retry or cancel.